Skip to content

Add one sentence per line to the style guide #2470

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Apr 29, 2025
Merged

Add one sentence per line to the style guide #2470

merged 2 commits into from
Apr 29, 2025

Conversation

oraNod
Copy link
Contributor

@oraNod oraNod commented Mar 25, 2025

Fixes #2463

@oraNod oraNod requested review from samccann and webknjaz March 25, 2025 21:01
@gotmax23
Copy link
Collaborator

Have you considered https://sembr.org instead? We try to use it for Packaging Guidelines and other docs in Fedora.

@oraNod
Copy link
Contributor Author

oraNod commented Mar 26, 2025

Have you considered https://sembr.org instead? We try to use it for Packaging Guidelines and other docs in Fedora.

Hey, thanks for mentioning sembr @gotmax23 I'm familiar with it. That set of conventions seems a bit too prescriptive. My feeling is that it's better to keep it simple and limited to more of a general guideline / best practice.

I'm certainly open to sembr if other folks think it's worth going in that direction though.

@felixfontein
Copy link
Collaborator

I agree that one sentence per line is already much bettre than the status quo.

How about formulating it "at least one line per sentence"? That would allow folks to adhere to sembr already now.

@webknjaz
Copy link
Member

I like it.

@samccann samccann added backport-2.17 Automatically create a backport for the stable-2.17 branch backport-2.18 Automatically create a backport for the stable-2.18 branch backport-2.19 Automatically create a backport for the stable-2.19 branch labels Apr 22, 2025
@samccann samccann merged commit 6aacf90 into ansible:devel Apr 29, 2025
12 checks passed
@patchback Patchback
Copy link

patchback bot commented Apr 29, 2025 •
edited
Loading

Backport to stable-2.17: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.17/6aacf90f33a9d700bae35c8a18c28e75fadb88a4/pr-2470

Backported as #2578

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Apr 29, 2025
@oraNod @samccann @patchback
Add one sentence per line to the style guide (#2470)
5c35f39 
* issue #2463 one sentence per line style guide

* Apply suggestions from code review

---------

Co-authored-by: Sandra McCann <[email protected]>
(cherry picked from commit 6aacf90)
@patchback patchback bot mentioned this pull request Apr 29, 2025
Merged
@patchback Patchback
Copy link

patchback bot commented Apr 29, 2025 •
edited
Loading

Backport to stable-2.18: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.18/6aacf90f33a9d700bae35c8a18c28e75fadb88a4/pr-2470

Backported as #2579

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Apr 29, 2025
@oraNod @samccann @patchback
Add one sentence per line to the style guide (#2470)
1ecfd78 
* issue #2463 one sentence per line style guide

* Apply suggestions from code review

---------

Co-authored-by: Sandra McCann <[email protected]>
(cherry picked from commit 6aacf90)
@patchback patchback bot mentioned this pull request Apr 29, 2025
Merged
@patchback Patchback
Copy link

patchback bot commented Apr 29, 2025 •
edited
Loading

Backport to stable-2.19: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.19/6aacf90f33a9d700bae35c8a18c28e75fadb88a4/pr-2470

Backported as #2580

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Apr 29, 2025
@oraNod @samccann @patchback
Add one sentence per line to the style guide (#2470)
726268b 
* issue #2463 one sentence per line style guide

* Apply suggestions from code review

---------

Co-authored-by: Sandra McCann <[email protected]>
(cherry picked from commit 6aacf90)
@patchback patchback bot mentioned this pull request Apr 29, 2025
Merged
samccann added a commit that referenced this pull request May 6, 2025
@patchback @oraNod @samccann
Add one sentence per line to the style guide (#2470) (#2580)
b8446fe 
* issue #2463 one sentence per line style guide

* Apply suggestions from code review

---------


(cherry picked from commit 6aacf90)

Co-authored-by: Don Naro <[email protected]>
Co-authored-by: Sandra McCann <[email protected]>
samccann added a commit that referenced this pull request May 6, 2025
@patchback @oraNod @samccann
Add one sentence per line to the style guide (#2470) (#2579)
8e0b77d 
* issue #2463 one sentence per line style guide

* Apply suggestions from code review

---------


(cherry picked from commit 6aacf90)

Co-authored-by: Don Naro <[email protected]>
Co-authored-by: Sandra McCann <[email protected]>
samccann added a commit that referenced this pull request May 6, 2025
@patchback @oraNod @samccann
Add one sentence per line to the style guide (#2470) (#2578)
37660b5 
* issue #2463 one sentence per line style guide

* Apply suggestions from code review

---------


(cherry picked from commit 6aacf90)

Co-authored-by: Don Naro <[email protected]>
Co-authored-by: Sandra McCann <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@samccann samccann samccann approved these changes

@webknjaz webknjaz Awaiting requested review from webknjaz

Assignees
No one assigned
Labels
backport-2.17 Automatically create a backport for the stable-2.17 branch backport-2.18 Automatically create a backport for the stable-2.18 branch backport-2.19 Automatically create a backport for the stable-2.19 branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

PR diffs, and git commits, are harder to read than they could be
5 participants
@oraNod @gotmax23 @felixfontein @webknjaz @samccann